Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use helm-docs to automatically generate Helm docs #2058

Merged
merged 1 commit into from
Jun 6, 2024
Merged

Use helm-docs to automatically generate Helm docs #2058

merged 1 commit into from
Jun 6, 2024

Conversation

lucacome
Copy link
Member

Proposed changes

Problem: It's hard to keep the README up-to-date and it's a manual process

Solution: Use norwoodj/helm-docs to automatically generate the docs from the values.yaml file

Closes #2044

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

NONE

@github-actions github-actions bot added documentation Improvements or additions to documentation helm-chart Relates to helm chart labels May 29, 2024
@lucacome lucacome force-pushed the docs/helm-docs branch 4 times, most recently from 9729e94 to 04153d7 Compare June 3, 2024 22:23
@lucacome lucacome marked this pull request as ready for review June 3, 2024 22:23
@lucacome lucacome requested a review from a team as a code owner June 3, 2024 22:23
@lucacome
Use helm-docs to automatically generate Helm docs
eec5984 
Problem: It's hard to keep the README up-to-date and it's a manual process

Solution: Use norwoodj/helm-docs to automatically generate the docs from the values.yaml file
@lucacome lucacome self-assigned this Jun 6, 2024
@lucacome lucacome merged commit 9e55882 into nginxinc:main Jun 6, 2024
48 checks passed
@lucacome lucacome deleted the docs/helm-docs branch June 10, 2024 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kate-osborn kate-osborn kate-osborn left review comments

@ciarams87 ciarams87 ciarams87 approved these changes

@sjberman sjberman sjberman approved these changes

Assignees

@lucacome lucacome

Labels
documentation Improvements or additions to documentation helm-chart Relates to helm chart
Projects
NGINX Gateway Fabric
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Use helm-docs to automatically generate Helm docs
4 participants
@lucacome @sjberman @ciarams87 @kate-osborn